Before adding an EDI mailbox, you must define the trading partner who sends or receives the EDI. See the EDI Trading Partner form in the N4 client: Administration EDI
EDI Configuration
EDI Configuration view
EDI Trading Partner form
To create an EDI mailbox:
In the N4 client, open the EDI Configuration view: Administration EDI
EDI Configuration
EDI Configuration view
In the left pane, expand the Complex by clicking the plus symbol. If they are properly defined, you see a list of trading partners.
Expand the hierarchy under the trading partner for which you want to create the outbound stowplan mailbox. N4 displays the sessions and the mailboxes for that trading partner in the tree structure below the trading partner's name.
With the trading partner name highlighted, click .
Choose EDI Mailbox from the drop-down list.
In the EDI Mailbox form, in the Mailbox Name field, enter a mailbox name.
Use a short and clear name.
From the Complex drop-down list, select the complex for which the EDI mailbox is set up.
If you are logged in at a complex or a lower scope level, you can add EDI mailboxes only for the current complex.
From the Direction drop-down list, select Send if this is a mailbox for an outbound message (meaning, N4 extracts the data, maps it into an EDI message file, and sends it to the selected trading partner) or Receive if this is a mailbox for an inbound message.
Once saved, you cannot edit the direction for an EDI mailbox.
In the Directory field, enter the absolute path of the folder where the EDI messages will be stored locally for your site.
N4 automatically creates a folder on the local server using the absolute path entered in the Directory field.
You cannot set Directory to a root directory, such as C:/ in Windows.
From the Communication Type drop-down list, select a transfer method for the EDI messages sent to or received by the terminal:
FTP: The message file is transferred using the standard file transfer protocol. To use this method, you specify the following additional information:
FTP Address: IP address or host name of the FTP server used to transfer EDI files.
The FTP server host name is preferred because the host name does not change while the IP address can change.
FTP User Id: User ID for the FTP server.
FTP Password: Password for the FTP server. To confirm the FTP password, you must retype the same password in the second field.
FTP Folder: Absolute path of the folder on the FTP server where EDI message files are placed for transmission.
SFTP: The message file is transferred using the secure file transfer protocol. To use this method, you must specify the same additional information, such as the address, user ID, password, and folder, as for FTP.
To use SFTP, both the terminal and the trading partner must support the technology.
Email: N4 transfers the message file as an email attachment. The email address used is specified in the Email Address field.
You can use a comma-separated list to specify multiple email addresses when configuring an EDI mailbox with the direction Send.
When an EDI message file is sent as an attachment, it is moved to the archive folder on the local file server.
To transfer EDI by email, make sure you have configured the EDI configuration settings. See the EDI Settings form in the N4 client: Administration EDI
EDI Configuration
EDI Configuration view
EDI Session form
Settings tab
EDI Setting form.
SOAP: The message file is transferred using the simple object access protocol. For outgoing messages, N4 provides a Web Service for the EDI partner to dynamically request an outbound EDI extract. N4 returns the results of the extract in response to the Web Service request.
N4 only supports processing of outbound vessel extract EDI via web services API using SOAP communication type.
NONE: The file communication is not controlled within N4.
Click Save.
The following table lists the optional fields for outbound X.12 standard EDI messages in the EDI Mailbox form:
Field Label |
Description |
---|---|
Sender Qualifier |
Enter the qualifier code to indicate the type of information in the Sender Id field. For example, ZZ is a common qualifier code. For more information on the X.12 standard, go to www.x12.org. |
Sender Id |
Enter the sender code you publish to your EDI trading partner to route EDI messages. |
Receiver Qualifier |
Enter the qualifier code to indicate the type of information in the Receiver Id field. For example, ZZ is a common qualifier code for the X.12 standard. |
Receiver Id |
Enter the receiver code that your EDI trading partner publishes. |
The Sender Qualifier, Sender Id, Receiver Qualifier, and Receiver Id fields appear in the header segments of the outbound X.12 standard EDI message as specified in the mapping file and are used to identify the EDI sender and receiver.